fix(docs): remove stale reference/http-api nav entry (#719)#767
Open
ZhYGuoL wants to merge 2 commits into
Open
fix(docs): remove stale reference/http-api nav entry (#719)#767ZhYGuoL wants to merge 2 commits into
ZhYGuoL wants to merge 2 commits into
Conversation
docs/reference/meta.json listed "http-api" in pages, but no docs/reference/http-api.md/.mdx file exists, so the sidebar nav pointed at a page that never renders. check-docs.mjs only validated the forward direction (every markdown file is reachable from nav), so the dangling entry passed CI. Remove the stale slug and add a reverse-direction check in scripts/check-docs.mjs: any meta.json#pages slug that resolves to no .md/.mdx file, folder index, or content folder now fails docs:check. Signed-off-by: ZhYGuoL <[email protected]>
Contributor
|
@ZhYGuoL is attempting to deploy a commit to the Vercel Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs/reference/meta.jsonlistedhttp-apiin itspagesarray, but nodocs/reference/http-api.md/.mdxexists, so the sidebar nav dangled at a page that never renders.docs:checkpassed anyway because it only checked the forward direction (every file is reachable from nav), never the reverse.What changed
http-apislug fromdocs/reference/meta.json#pages, preserving the order of the remaining pages (typescript-api,cli,project-layout).scripts/check-docs.mjs: everymeta.json#pagesslug must resolve to a real.md/.mdxfile, folder index, or content folder. It mirrorsisCoveredByNav()so legitimate folder references (reference,guides/client,channels, ...) are not false positives.How I verified
node ./scripts/check-docs.mjsexits 0 with the stale slug present; the dangling entry goes undetected.pnpm docs:checkpasses (exit 0), 75 files validated. Temporarily restoringhttp-apitrips the new check, which reportsdocs/reference/http-api (meta.json#pages)as a dangling sidebar link and exits 1.scripts/check-docs.mjsis the regression guard (fails with the stale slug present, passes without it). Full local green:pnpm lint,pnpm typecheck,pnpm test:unit(4683 passed, 1 skipped),pnpm docs:check.Closes #719.